Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DRAFT: serialisation docs #1141

Closed
wants to merge 10 commits into from
Closed

DRAFT: serialisation docs #1141

wants to merge 10 commits into from

Conversation

doug-q
Copy link
Collaborator

@doug-q doug-q commented May 30, 2024

We modify the schema so that hierarchy edges are stored outside of nodes, just as other edges are.

@doug-q doug-q requested a review from a team as a code owner May 30, 2024 14:11
@doug-q doug-q requested a review from ss2165 May 30, 2024 14:11
@hugrbot
Copy link
Collaborator

hugrbot commented May 30, 2024 •
edited
Loading

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification
and it looks like your proposed title needs to be adjusted.

Your title should look like this. The scope field is optional.

<type>(<scope>): <description>

If the PR includes a breaking change, mark it with an exclamation mark:

<type>!: <description>

and include a "BREAKING CHANGE:" footer in the body of the pull request.

Details:

Unknown release type "DRAFT" found in pull request title "DRAFT: serialisation docs". 

Available types:
 - feat
 - fix
 - docs
 - style
 - refactor
 - perf
 - test
 - ci
 - chore
 - revert

@codecov Codecov
Copy link

codecov bot commented May 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 88.88889% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 86.95%. Comparing base (1032b7a) to head (34ec245).
Report is 1 commits behind head on main.

Files Patch % Lines
hugr-py/src/hugr/serialization/serial_hugr.py 83.33% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1141      +/-   ##
==========================================
+ Coverage   86.92%   86.95%   +0.03%     
==========================================
  Files          91       91              
  Lines       18697    18619      -78     
  Branches    18304    18222      -82     
==========================================
- Hits        16252    16190      -62     
+ Misses       1596     1583      -13     
+ Partials      849      846       -3
Flag Coverage Δ
python 83.37% <88.88%> (+0.16%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ss2165
ss2165 reviewed May 30, 2024
View reviewed changes
Copy link
Member

@ss2165 ss2165 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall

DEVELOPMENT.md Outdated Show resolved Hide resolved
hugr-core/src/hugr/serialize/test.rs
/// Returns the deserialized HUGR.
pub fn check_hugr_schema_roundtrip(hugr: &Hugr) -> Hugr {
check_hugr_roundtrip(hugr, true)
fn ser_deserialize_check_schema<T: serde::de::DeserializeOwned>(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fn ser_deserialize_check_schema<T: serde::de::DeserializeOwned>(
fn deserialize_check_schema<T: serde::de::DeserializeOwned>(

@doug-q @ss2165
Update DEVELOPMENT.md
34ec245 
Co-authored-by: Seyon Sivarajah <seyon.sivarajah@quantinuum.com>
@doug-q doug-q linked an issue Jun 28, 2024 that may be closed by this pull request
Implement and document schema upgrades #1235
Closed
@doug-q doug-q closed this Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ss2165 ss2165 ss2165 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement and document schema upgrades
3 participants
@doug-q @hugrbot @ss2165